Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dm/tsa doc #1255

Merged
merged 17 commits into from
Dec 16, 2024
Merged

Dm/tsa doc #1255

merged 17 commits into from
Dec 16, 2024

Conversation

DarkaMaul
Copy link
Collaborator

@DarkaMaul DarkaMaul commented Dec 12, 2024

Summary

Revamp the documentation to use mkdocs.

Tasks

  • Build mkdocs site
  • Migrate Pdoc API to mkdocstrings
  • Integrate content from the README
  • Update CI to build / push documentation

Signed-off-by: Alexis <alexis.challande@trailofbits.com>
Signed-off-by: Alexis <alexis.challande@trailofbits.com>
Signed-off-by: Alexis <alexis.challande@trailofbits.com>
Signed-off-by: Alexis <alexis.challande@trailofbits.com>
Signed-off-by: Alexis <alexis.challande@trailofbits.com>
scripts/gen_ref_pages.py Outdated Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
Signed-off-by: Alexis <alexis.challande@trailofbits.com>
Signed-off-by: Alexis <alexis.challande@trailofbits.com>
Signed-off-by: Alexis <alexis.challande@trailofbits.com>
@DarkaMaul DarkaMaul marked this pull request as ready for review December 16, 2024 09:07
Signed-off-by: Alexis <alexis.challande@trailofbits.com>
Signed-off-by: Alexis <alexis.challande@trailofbits.com>
Signed-off-by: Alexis <alexis.challande@trailofbits.com>
Copy link
Member

@woodruffw woodruffw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work @DarkaMaul!

@woodruffw woodruffw merged commit 25e0ad4 into sigstore:main Dec 16, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants